You are here: Appendix B: VBScript reference > About the event procedures > About the project workflow events > ProjectWorkflowEvent_PrepareBrowser event

ProjectWorkflowEvent_PrepareBrowser event

Occurs before the folder selection dialog box is shown for the user to select a destination folder for a project copy.

Syntax

ProjectWorkflowEvent_ PrepareBrowser(RootFolder, DialogTitle)
Parameters
Name Description

RootFolder

The path of the folder to show as the root in the Select Folder dialog.

DialogTitle

Custom title to show for the Select Folder dialog.

Remarks

This event and the ProjectWorkflowEvent_InitializeExpandItem and ProjectWorkflowEvent_BeforeExpandItem events can be used to restrict the destination project folder selected by a user.

The folder selection dialog box can be shown for new non-project copy documents by setting Client.Confirmation (AS_CONFIRM_NO_SELECTPROJECTWIZARD) = False in the DocGenericEvent_BeforeNewDocument event. The selected folder can then be retrieved in the DocGenericEvent_DocumentFolderSelected event described in the BlueCielo Meridian Enterprise VBScript API Reference.

If the folder that was last selected by the user is a subfolder of the folder specified by RootFolder, it is selected by default in the folder selection dialog box. Otherwise, the folder specified by RootFolder is selected by default.

By default, when the project folder selection dialog box appears, the root of the vault is highlighted and can be selected. To prevent users from from clicking the OK button and selecting the root and to force them to select or create a project folder, set the AS_CONFIRM_ROOT_SELECTION constant to False in this event. The default value is True.

Examples

The following example shows how to initialize the Select Folder dialog box with a preset root folder. The user must then select a subfolder as the destination of the project copy.

Sub ProjectWorkflowEvent_PrepareBrowser(RootFolder, DialogTitle)
    RootFolder = "\projects"
    DialogTitle = "Select Project"
End Sub

The following example demonstrates how to assign a project copy to a known destination project folder (retrieved from a document property, for example) and how to suppress the Select Folder and Reference Explorer (for reference selection if references exist) dialog boxes. The DocCopyMoveEvent_PrepareCopy event occurs before ProjectWorkflowEvent_PrepareBrowser and in this example, the browser is not shown.

Sub DocCopyMoveEvent_PrepareCopy(Batch, TargetFolder)
  If Not Document Is Nothing Then
    If Client.ImportType = AS_IT_COPIED And _
      Client.ImportDetails = AS_ID_CREATEPROJCOPY Then
      'Add your code for document objects
      TargetFolder = "\Design\Projects\894" 'Or some property value
      'Suppress folder selection dialog
      Client.Confirmation(AS_CONFIRM_PROJECT_FOLDER) = False
      'Suppress reference selection dialog
      Client.Confirmation(AS_CONFIRM_SELECT_ASSEMBLY_ITEMS) = False
    End If
  ElseIf Not Folder Is Nothing Then
    'Add your code for folder objects
  End If
End Sub

Related concepts

About the project workflow events

Related information

ProjectWorkflowEvent_*ChangeManager events

ProjectWorkflowEvent_*ExecuteTransition events

ProjectWorkflowEvent_*Reroute events

ProjectWorkflowEvent_BeforeExpandItem event

ProjectWorkflowEvent_InitializeExpandItem event

ProjectWorkflowEvent_InitializeWizard event

ProjectWorkflowEvent_TerminateWizard event


www.bluecieloecm.com